Class AssessmentModelScriptInterfaceImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.AssessmentModelScriptInterfaceImpl
All Implemented Interfaces:
IPCObject, AssessmentModelScriptInterface

public class AssessmentModelScriptInterfaceImpl extends IPCObjectImpl implements AssessmentModelScriptInterface
Information provided by the PKI file:

    \class AssessmentModelScriptInterface
    
    \brief This class handles the Assessment Model Script Interface.
    
    \example appWindow().getActiveFile().getActivityScriptEngine().getAssessmentModelScriptInterface()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getAssessmentItemValue

      public String getAssessmentItemValue(String networkType, String idpath)
      Information provided by the PKI file:
      
          \brief Returns the value of the assessment item for the specified network at the given node.
          
          \param networkType, where the following are valid network types: user, answer, initial, lastAssessed, assessed.
          \param idpath, the path to the assessment item node. For example, Network:PC0:Default Gateway.
          
          \return QString, the value of the assessment item for the specified network.
          
              
      Specified by:
      getAssessmentItemValue in interface AssessmentModelScriptInterface
      Parameters:
      networkType - Takes in a parameter of networkType
      idpath - Takes in a parameter of idpath
      Returns:
      String Returns a String
    • peakAssessmentItemID

      public List<String> peakAssessmentItemID(String networkType, String idpath)
      Information provided by the PKI file:
      
          \brief Returns the list of child assessment node IDs for the specified network at the given node.
          
          \param networkType, where the following are valid network types: user, answer, initial, lastAssessed, assessed.
          \param idpath, the path to the assessment item node. For example, Network:PC0.
          
          \return vector<QString>, the list of child assessment node IDs for the specified network at the given node.
          
              
      Specified by:
      peakAssessmentItemID in interface AssessmentModelScriptInterface
      Parameters:
      networkType - Takes in a parameter of networkType
      idpath - Takes in a parameter of idpath
      Returns:
      List<String> Returns a List<String>
    • setAssessmentItemFeedback

      public boolean setAssessmentItemFeedback(String idpath, String feedback)
      Information provided by the PKI file:
      
          \brief Sets the assessment item feedback string.
          
          \remark Affects the Check Results display only. It does not change it in the model.
          The Activity Results page must be displayed. Refreshing the display is required.
          
          \return bool, true if the assessment item feedback was set successfully, otherwise false.
          
              
      Specified by:
      setAssessmentItemFeedback in interface AssessmentModelScriptInterface
      Parameters:
      idpath - Takes in a parameter of idpath
      feedback - Takes in a parameter of feedback
      Returns:
      boolean Returns a boolean
    • refreshAssessmentItemsView

      public boolean refreshAssessmentItemsView()
      Information provided by the PKI file:
      
          \brief Updates the Assessment Item tree view in the Activity Results page.
          
          \remark The Activity Results page must be displayed. Refreshing the display is required.
          
          \return bool, true if the Assessment Items view was refreshed successfully, otherwise false.
          
              
      Specified by:
      refreshAssessmentItemsView in interface AssessmentModelScriptInterface
      Returns:
      boolean Returns a boolean
    • setUseCache

      public void setUseCache(boolean cache)
      Information provided by the PKI file:
      
          \brief Enables or Disable the TreeNodes to be cached
          \remark The activity comparator tree is a huge tree in larger networks, and performance may degrade.
          If you do not require the latest values from the tree, you can enable the cache that will get it
          from the latest creation of the tree. It is best to enable the cache for a set of calls and disable it after.
          Disabling the cache will clear the cache.
          Use it in the order of: 1. enable the cache, 2. get values, 3. disable the cache
          
          \param cache, if true the Tree Nodes will be cached, false and they won't.
          
              
      Specified by:
      setUseCache in interface AssessmentModelScriptInterface
      Parameters:
      cache - Takes in a parameter of cache